<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxHeightFieldDesc Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxHeightFieldDesc.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classPxHeightFieldDesc-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxHeightFieldDesc Class Reference<div class="ingroups"><a class="el" href="group__geomutils.html">Geomutils</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Descriptor class for <a class="el" href="classPxHeightField.html" title="A height field class. ">PxHeightField</a>.  
 <a href="classPxHeightFieldDesc.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxHeightFieldDesc_8h_source.html">PxHeightFieldDesc.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for PxHeightFieldDesc:</div>
<div class="dyncontent">
<div class="center"><img src="classPxHeightFieldDesc__coll__graph.png" border="0" usemap="#PxHeightFieldDesc_coll__map" alt="Collaboration graph"/></div>
<map name="PxHeightFieldDesc_coll__map" id="PxHeightFieldDesc_coll__map">
<area shape="rect" id="node2" href="classPxFlags.html" title="PxFlags\&lt; PxHeightFieldFlag\l::Enum, PxU16 \&gt;" alt="" coords="5,5,193,47"/>
<area shape="rect" id="node3" href="structPxStridedData.html" title="PxStridedData" alt="" coords="218,13,325,39"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ga0e3fd140462fac286debed6c6a960c3d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__geomutils.html#ga0e3fd140462fac286debed6c6a960c3d">PxHeightFieldDesc</a> ()</td></tr>
<tr class="memdesc:ga0e3fd140462fac286debed6c6a960c3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor sets to default.  <a href="group__geomutils.html#ga0e3fd140462fac286debed6c6a960c3d">More...</a><br /></td></tr>
<tr class="separator:ga0e3fd140462fac286debed6c6a960c3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadd7ec6c255262ddceeb7e04600bc47b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__geomutils.html#gadd7ec6c255262ddceeb7e04600bc47b5">setToDefault</a> ()</td></tr>
<tr class="memdesc:gadd7ec6c255262ddceeb7e04600bc47b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">(re)sets the structure to the default.  <a href="group__geomutils.html#gadd7ec6c255262ddceeb7e04600bc47b5">More...</a><br /></td></tr>
<tr class="separator:gadd7ec6c255262ddceeb7e04600bc47b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0e0681b04cf2ae73994df0939e74e85f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__geomutils.html#ga0e0681b04cf2ae73994df0939e74e85f">isValid</a> () const</td></tr>
<tr class="memdesc:ga0e0681b04cf2ae73994df0939e74e85f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the descriptor is valid.  <a href="group__geomutils.html#ga0e0681b04cf2ae73994df0939e74e85f">More...</a><br /></td></tr>
<tr class="separator:ga0e0681b04cf2ae73994df0939e74e85f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ac701700af3c4597a4a39a76e3331dd08"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldDesc.html#ac701700af3c4597a4a39a76e3331dd08">nbRows</a></td></tr>
<tr class="memdesc:ac701700af3c4597a4a39a76e3331dd08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of sample rows in the height field samples array.  <a href="#ac701700af3c4597a4a39a76e3331dd08">More...</a><br /></td></tr>
<tr class="separator:ac701700af3c4597a4a39a76e3331dd08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8426b15eb6ad44c11fcb84bb9e3350c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldDesc.html#a8426b15eb6ad44c11fcb84bb9e3350c0">nbColumns</a></td></tr>
<tr class="memdesc:a8426b15eb6ad44c11fcb84bb9e3350c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of sample columns in the height field samples array.  <a href="#a8426b15eb6ad44c11fcb84bb9e3350c0">More...</a><br /></td></tr>
<tr class="separator:a8426b15eb6ad44c11fcb84bb9e3350c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8743d198a4db234d353c1f4d2734d43d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPxHeightFieldFormat.html#ad28e3afa439f8ff1df6067288c46d9c5">PxHeightFieldFormat::Enum</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldDesc.html#a8743d198a4db234d353c1f4d2734d43d">format</a></td></tr>
<tr class="memdesc:a8743d198a4db234d353c1f4d2734d43d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Format of the sample data.  <a href="#a8743d198a4db234d353c1f4d2734d43d">More...</a><br /></td></tr>
<tr class="separator:a8743d198a4db234d353c1f4d2734d43d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affbec0b3ed43d041b12152648d13821b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPxStridedData.html">PxStridedData</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldDesc.html#affbec0b3ed43d041b12152648d13821b">samples</a></td></tr>
<tr class="memdesc:affbec0b3ed43d041b12152648d13821b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The samples array.  <a href="#affbec0b3ed43d041b12152648d13821b">More...</a><br /></td></tr>
<tr class="separator:affbec0b3ed43d041b12152648d13821b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c40081aa73ec042021785dbe52f75fb"><td class="memItemLeft" align="right" valign="top">PxReal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldDesc.html#a2c40081aa73ec042021785dbe52f75fb">convexEdgeThreshold</a></td></tr>
<tr class="separator:a2c40081aa73ec042021785dbe52f75fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec8940d776191d6ca950025836481360"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__geomutils.html#ga93b547b1968a59b2d23c91aab533e2c8">PxHeightFieldFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxHeightFieldDesc.html#aec8940d776191d6ca950025836481360">flags</a></td></tr>
<tr class="memdesc:aec8940d776191d6ca950025836481360"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags bits, combined from values of the enum <a class="el" href="structPxHeightFieldFlag.html" title="Enum with flag values to be used in PxHeightFieldDesc.flags. ">PxHeightFieldFlag</a>.  <a href="#aec8940d776191d6ca950025836481360">More...</a><br /></td></tr>
<tr class="separator:aec8940d776191d6ca950025836481360"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Descriptor class for <a class="el" href="classPxHeightField.html" title="A height field class. ">PxHeightField</a>. </p>
<dl class="section note"><dt>Note</dt><dd>The heightfield data is *copied* when a <a class="el" href="classPxHeightField.html" title="A height field class. ">PxHeightField</a> object is created from this descriptor. After the call the user may discard the height data.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxHeightField.html" title="A height field class. ">PxHeightField</a> <a class="el" href="classPxHeightFieldGeometry.html" title="Height field geometry class. ">PxHeightFieldGeometry</a> <a class="el" href="classPxShape.html" title="Abstract class for collision shapes. ">PxShape</a> <a class="el" href="classPxPhysics.html#a1806546c22306e8d44b7ff7719fbcc99" title="Creates a heightfield object from previously cooked stream. ">PxPhysics.createHeightField()</a> <a class="el" href="classPxCooking.html#a0a3d0ec6145be91dd6707535724d8ffb" title="Cooks and creates a heightfield mesh and inserts it into PxPhysics. ">PxCooking.createHeightField()</a> </dd></dl>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a2c40081aa73ec042021785dbe52f75fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c40081aa73ec042021785dbe52f75fb">&#9670;&nbsp;</a></span>convexEdgeThreshold</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxReal PxHeightFieldDesc::convexEdgeThreshold</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This threshold is used by the collision detection to determine if a height field edge is convex and can generate contact points. Usually the convexity of an edge is determined from the angle (or cosine of the angle) between the normals of the faces sharing that edge. The height field allows a more efficient approach by comparing height values of neighboring vertices. This parameter offsets the comparison. Smaller changes than 0.5 will not alter the set of convex edges. The rule of thumb is that larger values will result in fewer edge contacts.</p>
<p>This parameter is ignored in contact generation with sphere and capsule primitives.</p>
<p><b>Range:</b> [0, PX_MAX_F32)<br />
 <b>Default:</b> 0 </p>

</div>
</div>
<a id="aec8940d776191d6ca950025836481360"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec8940d776191d6ca950025836481360">&#9670;&nbsp;</a></span>flags</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__geomutils.html#ga93b547b1968a59b2d23c91aab533e2c8">PxHeightFieldFlags</a> PxHeightFieldDesc::flags</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Flags bits, combined from values of the enum <a class="el" href="structPxHeightFieldFlag.html" title="Enum with flag values to be used in PxHeightFieldDesc.flags. ">PxHeightFieldFlag</a>. </p>
<p><b>Default:</b> 0</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structPxHeightFieldFlag.html" title="Enum with flag values to be used in PxHeightFieldDesc.flags. ">PxHeightFieldFlag</a> <a class="el" href="group__geomutils.html#ga93b547b1968a59b2d23c91aab533e2c8" title="collection of set bits defined in PxHeightFieldFlag. ">PxHeightFieldFlags</a> </dd></dl>

</div>
</div>
<a id="a8743d198a4db234d353c1f4d2734d43d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8743d198a4db234d353c1f4d2734d43d">&#9670;&nbsp;</a></span>format</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structPxHeightFieldFormat.html#ad28e3afa439f8ff1df6067288c46d9c5">PxHeightFieldFormat::Enum</a> PxHeightFieldDesc::format</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Format of the sample data. </p>
<p>Currently the only supported format is <a class="el" href="structPxHeightFieldFormat.html#ad28e3afa439f8ff1df6067288c46d9c5aa8ba1edf74a561d830b5f40e2c3e64e7" title="Height field height data is 16 bit signed integers, followed by triangle materials. ">PxHeightFieldFormat::eS16_TM</a>:</p>
<p><b>Default:</b> <a class="el" href="structPxHeightFieldFormat.html#ad28e3afa439f8ff1df6067288c46d9c5aa8ba1edf74a561d830b5f40e2c3e64e7" title="Height field height data is 16 bit signed integers, followed by triangle materials. ">PxHeightFieldFormat::eS16_TM</a></p>
<dl class="section see"><dt>See also</dt><dd>PxHeightFormat <a class="el" href="classPxHeightFieldDesc.html#affbec0b3ed43d041b12152648d13821b" title="The samples array. ">PxHeightFieldDesc.samples</a> </dd></dl>

</div>
</div>
<a id="a8426b15eb6ad44c11fcb84bb9e3350c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8426b15eb6ad44c11fcb84bb9e3350c0">&#9670;&nbsp;</a></span>nbColumns</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxHeightFieldDesc::nbColumns</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of sample columns in the height field samples array. </p>
<dl class="section note"><dt>Note</dt><dd>Local space Z-axis corresponds to columns.</dd></dl>
<p><b>Range:</b> &gt;1<br />
 <b>Default:</b> 0 </p>

</div>
</div>
<a id="ac701700af3c4597a4a39a76e3331dd08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac701700af3c4597a4a39a76e3331dd08">&#9670;&nbsp;</a></span>nbRows</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxHeightFieldDesc::nbRows</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of sample rows in the height field samples array. </p>
<dl class="section note"><dt>Note</dt><dd>Local space X-axis corresponds to rows.</dd></dl>
<p><b>Range:</b> &gt;1<br />
 <b>Default:</b> 0 </p>

</div>
</div>
<a id="affbec0b3ed43d041b12152648d13821b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affbec0b3ed43d041b12152648d13821b">&#9670;&nbsp;</a></span>samples</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structPxStridedData.html">PxStridedData</a> PxHeightFieldDesc::samples</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The samples array. </p>
<p>It is copied to the SDK's storage at creation time.</p>
<p>There are nbRows * nbColumn samples in the array, which define nbRows * nbColumn vertices and cells, of which (nbRows - 1) * (nbColumns - 1) cells are actually used.</p>
<p>The array index of sample(row, column) = row * nbColumns + column. The byte offset of sample(row, column) = sampleStride * (row * nbColumns + column). The sample data follows at the offset and spans the number of bytes defined by the format. Then there are zero or more unused bytes depending on sampleStride before the next sample.</p>
<p><b>Default:</b> NULL</p>
<dl class="section see"><dt>See also</dt><dd>PxHeightFormat </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxHeightFieldDesc_8h_source.html">PxHeightFieldDesc.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classPxHeightFieldDesc.html">PxHeightFieldDesc</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
